Skip to content

Update Sphinx workflow for GitHub Pages deployment #12945

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Closed
wants to merge 1 commit into from
Closed

Update Sphinx workflow for GitHub Pages deployment #12945

wants to merge 1 commit into from

Conversation

AgustinWojtyszyn
Copy link

Enhance Sphinx GitHub Actions workflow

  • Use ubuntu-latest runner instead of ubuntu-24.04-arm for wider support
  • Add Python dependency caching for faster builds
  • Add descriptive step names for better readability in CI logs
  • Keep minimal required permissions for improved security
  • Maintain concurrency to prevent overlapping deployments

Describe your change:

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist:

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

@AgustinWojtyszyn
Update Sphinx workflow for GitHub Pages deployment
2db0f8a 
Enhance Sphinx GitHub Actions workflow

- Use ubuntu-latest runner instead of ubuntu-24.04-arm for wider support
- Add Python dependency caching for faster builds
- Add descriptive step names for better readability in CI logs
- Keep minimal required permissions for improved security
- Maintain concurrency to prevent overlapping deployments
@algorithms-keeper algorithms-keeper bot added the tests are failing Do not merge until tests pass label Sep 1, 2025
@cclauss
Copy link
Member

cclauss commented Sep 1, 2025

Use ubuntu-latest runner instead of ubuntu-24.04-arm for wider support

Why use a slower processor instead of a faster processor?!?

cclauss
cclauss reviewed Sep 1, 2025
View reviewed changes
.github/workflows/sphinx.yml
- uses: astral-sh/setup-uv@v6
- uses: actions/setup-python@v5
- name: Checkout repository
uses: actions/checkout@v5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actions/checkout@v5 tells the reader more than Checkout repository does.

cclauss
cclauss reviewed Sep 1, 2025
View reviewed changes
.github/workflows/sphinx.yml
uses: actions/checkout@v5

- name: Setup uv
uses: astral-sh/setup-uv@v6
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same.

cclauss
cclauss reviewed Sep 1, 2025
View reviewed changes
Copy link
Member

@cclauss cclauss left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

All of these changes either break, slow down, or dumb down a working GitHub Action.

.github/workflows/sphinx.yml
uses: astral-sh/setup-uv@v6

- name: Setup Python
uses: actions/setup-python@v5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same.

@cclauss cclauss closed this Sep 1, 2025
@AgustinWojtyszyn AgustinWojtyszyn deleted the patch-1 branch September 13, 2025 18:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@cclauss cclauss cclauss left review comments

Assignees

No one assigned

Labels

tests are failing Do not merge until tests pass

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@AgustinWojtyszyn @cclauss